home *** CD-ROM | disk | FTP | other *** search
/ MacHack 2000 / MacHack 2000.toast / pc / The Hacks / MacHacksBug / Python 1.5.2c1 / Extensions / Imaging / PIL / OleFileIO.py < prev    next >
Encoding:
Python Source  |  2000-06-23  |  12.7 KB  |  510 lines
  1. #
  2. # THIS IS WORK IN PROGRESS
  3. #
  4. # The Python Imaging Library
  5. # $Id: OleFileIO.py,v 1.1.1.2 1999/01/13 09:40:17 sjoerd Exp $
  6. #
  7. # stuff to deal with OLE2 Structured Storage files.  this module is
  8. # used by PIL to read Image Composer and FlashPix files, but can also
  9. # be used to read other files of this type.
  10. #
  11. # History:
  12. # 97-01-20 fl    Created
  13. # 97-01-22 fl    Fixed 64-bit portability quirk
  14. #
  15. # Notes:
  16. # FIXME: change filename to use "a/b/c" instead of ["a", "b", "c"]
  17. # FIXME: provide a glob mechanism function (using fnmatchcase)
  18. #
  19. # Literature:
  20. #
  21. # "FlashPix Format Specification, Appendix A", Kodak and Microsoft,
  22. #  September 1996.
  23. #
  24. # Quotes:
  25. # 
  26. # "If this document and functionality of the Software conflict,
  27. #  the actual functionality of the Software represents the correct
  28. #  functionality" -- Microsoft, in the OLE format specification
  29. #
  30. # Copyright (c) Secret Labs AB 1997.
  31. # Copyright (c) Fredrik Lundh 1997.
  32. #
  33. # See the README file for information on usage and redistribution.
  34. #
  35.  
  36.  
  37. import string, StringIO
  38.  
  39.  
  40. def i16(c, o = 0):
  41.     return ord(c[o])+(ord(c[o+1])<<8)
  42.  
  43. def i32(c, o = 0):
  44.     return ord(c[o])+(ord(c[o+1])<<8)+(ord(c[o+2])<<16)+(ord(c[o+3])<<24)
  45.  
  46.  
  47. MAGIC = '\320\317\021\340\241\261\032\341'
  48.  
  49. #
  50. # --------------------------------------------------------------------
  51. # property types
  52.  
  53. VT_EMPTY=0; VT_NULL=1; VT_I2=2; VT_I4=3; VT_R4=4; VT_R8=5; VT_CY=6;
  54. VT_DATE=7; VT_BSTR=8; VT_DISPATCH=9; VT_ERROR=10; VT_BOOL=11;
  55. VT_VARIANT=12; VT_UNKNOWN=13; VT_DECIMAL=14; VT_I1=16; VT_UI1=17;
  56. VT_UI2=18; VT_UI4=19; VT_I8=20; VT_UI8=21; VT_INT=22; VT_UINT=23;
  57. VT_VOID=24; VT_HRESULT=25; VT_PTR=26; VT_SAFEARRAY=27; VT_CARRAY=28;
  58. VT_USERDEFINED=29; VT_LPSTR=30; VT_LPWSTR=31; VT_FILETIME=64;
  59. VT_BLOB=65; VT_STREAM=66; VT_STORAGE=67; VT_STREAMED_OBJECT=68;
  60. VT_STORED_OBJECT=69; VT_BLOB_OBJECT=70; VT_CF=71; VT_CLSID=72;
  61. VT_VECTOR=0x1000;
  62.  
  63. # map property id to name (for debugging purposes)
  64.  
  65. VT = {}
  66. for k, v in vars().items():
  67.     if k[:3] == "VT_":
  68.     VT[v] = k
  69.  
  70. #
  71. # --------------------------------------------------------------------
  72. # Some common document types (root.clsid fields)
  73.  
  74. WORD_CLSID = "00020900-0000-0000-C000-000000000046"
  75.  
  76.  
  77. #
  78. # --------------------------------------------------------------------
  79.  
  80. class _OleStream(StringIO.StringIO):
  81.  
  82.     """OLE2 Stream
  83.  
  84.     Returns a read-only file object which can be used to read
  85.     the contents of a OLE stream.  To open a stream, use the
  86.     openstream method in the OleFile class.
  87.  
  88.     This function can be used with either ordinary streams,
  89.     or ministreams, depending on the offset, sectorsize, and
  90.     fat table arguments.
  91.     """
  92.  
  93.     # FIXME: should store the list of sects obtained by following
  94.     # the fat chain, and load new sectors on demand instead of
  95.     # loading it all in one go.
  96.  
  97.     def __init__(self, fp, sect, size, offset, sectorsize, fat):
  98.  
  99.     data = []
  100.  
  101.     while sect != 0xFFFFFFFE:
  102.         fp.seek(offset + sectorsize * sect)
  103.         data.append(fp.read(sectorsize))
  104.         sect = fat[sect]
  105.  
  106.     data = string.join(data, "")
  107.  
  108.     # print len(data), size
  109.  
  110.     StringIO.StringIO.__init__(self, data[:size])
  111.  
  112. #
  113. # --------------------------------------------------------------------
  114.  
  115. # FIXME: should add a counter in here to avoid looping forever
  116. # if the tree is broken.
  117.  
  118. class _OleDirectoryEntry:
  119.  
  120.     """OLE2 Directory Entry
  121.  
  122.     Encapsulates a stream directory entry.  Note that the
  123.     constructor builds a tree of all subentries, so we only
  124.     have to call it with the root object.
  125.     """
  126.  
  127.     def __init__(self, sidlist, sid):
  128.  
  129.     # store directory parameters.  the caller provides
  130.     # a complete list of directory entries, as read from
  131.     # the directory stream.
  132.  
  133.     name, type, sect, size, sids, clsid = sidlist[sid]
  134.  
  135.     self.sid  = sid
  136.     self.name = name
  137.     self.type = type # 1=storage 2=stream
  138.     self.sect = sect
  139.     self.size = size
  140.     self.clsid = clsid
  141.  
  142.     # process child nodes, if any
  143.  
  144.     self.kids = []
  145.  
  146.     sid = sidlist[sid][4][2]
  147.  
  148.     if sid != -1:
  149.  
  150.         # the directory entries are organized as a red-black tree.
  151.         # the following piece of code does an ordered traversal of
  152.         # such a tree (at least that's what I hope ;-)
  153.  
  154.         stack = [self.sid]
  155.  
  156.         # start at leftmost position
  157.  
  158.         left, right, child = sidlist[sid][4]
  159.  
  160.         while left != 0xFFFFFFFF:
  161.         stack.append(sid)
  162.         sid = left
  163.         left, right, child = sidlist[sid][4]
  164.  
  165.         while sid != self.sid:
  166.  
  167.         self.kids.append(_OleDirectoryEntry(sidlist, sid))
  168.  
  169.         # try to move right
  170.         left, right, child = sidlist[sid][4]
  171.         if right != 0xFFFFFFFF:
  172.             # and then back to the left
  173.             sid = right
  174.             while 1:
  175.             left, right, child = sidlist[sid][4]
  176.             if left == 0xFFFFFFFF:
  177.                 break
  178.             stack.append(sid)
  179.             sid = left
  180.         else:
  181.             # couldn't move right; move up instead
  182.             while 1:
  183.             ptr = stack[-1]
  184.             del stack[-1]
  185.             left, right, child = sidlist[ptr][4]
  186.             if right != sid:
  187.                 break
  188.             sid = right
  189.             left, right, child = sidlist[sid][4]
  190.             if right != ptr:
  191.                 sid = ptr
  192.  
  193.         # in the OLE file, entries are sorted on (length, name).
  194.         # for convenience, we sort them on name instead.
  195.  
  196.         self.kids.sort()
  197.  
  198.     def __cmp__(self, other):
  199.     "Compare entries by name"
  200.  
  201.     return cmp(self.name, other.name)
  202.  
  203.     def dump(self, tab = 0):
  204.     "Dump this entry, and all its subentries (for debug purposes only)"
  205.  
  206.     TYPES = ["(invalid)", "(storage)", "(stream)", "(lockbytes)",
  207.          "(property)", "(root)"]
  208.  
  209.     print " "*tab + repr(self.name), TYPES[self.type],
  210.     if self.type in (2, 5):
  211.         print self.size, "bytes",
  212.     print
  213.     if self.type in (1, 5) and self.clsid:
  214.         print " "*tab + "{%s}" % self.clsid
  215.  
  216.     for kid in self.kids:
  217.         kid.dump(tab + 2)
  218.  
  219. #
  220. # --------------------------------------------------------------------
  221.  
  222. class OleFileIO:
  223.     """OLE container object
  224.  
  225.     This class encapsulates the interface to an OLE 2 structured
  226.     storage file.  Use the listdir and openstream methods to access
  227.     the contents of this file.
  228.  
  229.     Object names are given as a list of strings, one for each subentry
  230.     level.  The root entry should be omitted.  For example, the following
  231.     code extracts all image streams from a Microsoft Image Composer file:
  232.  
  233.     ole = OleFileIO("fan.mic")
  234.  
  235.     for entry in ole.listdir():
  236.         if entry[1:2] == "Image":
  237.         fin = ole.openstream(entry)
  238.         fout = open(entry[0:1], "wb")
  239.         while 1:
  240.             s = fin.read(8192)
  241.             if not s:
  242.             break
  243.             fout.write(s)
  244.  
  245.     You can use the viewer application provided with the Python Imaging
  246.     Library to view the resulting files (which happens to be standard
  247.     TIFF files).
  248.     """
  249.  
  250.     def __init__(self, filename = None):
  251.  
  252.     if filename:
  253.         self.open(filename)
  254.  
  255.     def open(self, filename):
  256.     """Connect to a OLE2 file"""
  257.  
  258.     if type(filename) == type(""):
  259.         self.fp = open(filename, "rb")
  260.     else:
  261.         self.fp = filename
  262.  
  263.     header = self.fp.read(512)
  264.     
  265.     if len(header) != 512 or header[:8] != MAGIC:
  266.         raise IOError, "not an OLE2 structured storage file"
  267.  
  268.     # file clsid (probably never used, so we don't store it)
  269.     clsid = self._clsid(header[8:24])
  270.  
  271.     # FIXME: could check version and byte order fields
  272.  
  273.     self.sectorsize = 1 << i16(header, 30)
  274.     self.minisectorsize = 1 << i16(header, 32)
  275.  
  276.     self.minisectorcutoff = i32(header, 56)
  277.  
  278.     # Load file allocation tables
  279.     self.loadfat(header)
  280.  
  281.     # Load direcory.  This sets both the sidlist (ordered by id)
  282.     # and the root (ordered by hierarchy) members.
  283.     self.loaddirectory(i32(header, 48))
  284.  
  285.     self.ministream = None
  286.     self.minifatsect = i32(header, 60)
  287.  
  288.  
  289.     def loadfat(self, header):
  290.     # Load the FAT table.  The header contains a sector numbers
  291.     # for the first 109 FAT sectors.  Additional sectors are
  292.     # described by DIF blocks (FIXME: not yet implemented)
  293.  
  294.     sect = header[76:512]
  295.     fat = []
  296.     for i in range(0, len(sect), 4):
  297.         ix = i32(sect, i)
  298.         if ix in [0xFFFFFFFE, 0xFFFFFFFF]:
  299.         break
  300.         s = self.getsect(ix)
  301.         fat = fat + map(lambda i, s=s: i32(s, i), range(0, len(s), 4))
  302.     self.fat = fat
  303.  
  304.     def loadminifat(self):
  305.     # Load the MINIFAT table.  This is stored in a standard sub-
  306.     # stream, pointed to by a header field.
  307.  
  308.     s = self._open(self.minifatsect).read()
  309.  
  310.     self.minifat = map(lambda i, s=s: i32(s, i), range(0, len(s), 4))
  311.  
  312.     def getsect(self, sect):
  313.     # Read given sector
  314.  
  315.     self.fp.seek(512 + self.sectorsize * sect)
  316.     return self.fp.read(self.sectorsize)
  317.  
  318.     def _unicode(self, s):
  319.     # Map unicode string to Latin 1
  320.  
  321.     # FIXME: some day, Python will provide an official way to handle
  322.     # Unicode strings, but until then, this will have to do...
  323.     return filter(ord, s)
  324.  
  325.     def loaddirectory(self, sect):
  326.     # Load the directory.  The directory is stored in a standard
  327.     # substream, independent of its size.
  328.  
  329.     # read directory stream
  330.     fp = self._open(sect)
  331.  
  332.     # create list of sid entries
  333.     self.sidlist = []
  334.     while 1:
  335.         entry = fp.read(128)
  336.         if not entry:
  337.         break
  338.         type = ord(entry[66])
  339.         name = self._unicode(entry[0:0+i16(entry, 64)])
  340.         ptrs = i32(entry, 68), i32(entry, 72), i32(entry, 76)
  341.         sect, size = i32(entry, 116), i32(entry, 120)
  342.         clsid = self._clsid(entry[80:96])
  343.         self.sidlist.append((name, type, sect, size, ptrs, clsid))
  344.  
  345.     # create hierarchical list of directory entries
  346.     self.root = _OleDirectoryEntry(self.sidlist, 0)
  347.  
  348.     def dumpdirectory(self):
  349.     # Dump directory (for debugging only)
  350.  
  351.     self.root.dump()
  352.  
  353.     def _clsid(self, clsid):
  354.     if clsid == "\0" * len(clsid):
  355.         return ""
  356.     return (("%08X-%04X-%04X-%02X%02X-" + "%02X" * 6) %
  357.         ((i32(clsid, 0), i16(clsid, 4), i16(clsid, 6)) +
  358.         tuple(map(ord, clsid[8:16]))))
  359.  
  360.     def _list(self, files, prefix, node):
  361.     # listdir helper
  362.  
  363.     prefix = prefix + [node.name]
  364.     for entry in node.kids:
  365.         if entry.kids:
  366.         self._list(files, prefix, entry)
  367.         else:
  368.         files.append(prefix[1:] + [entry.name])
  369.  
  370.     def _find(self, filename):
  371.     # openstream helper
  372.  
  373.     node = self.root
  374.     for name in filename:
  375.         for kid in node.kids:
  376.         if kid.name == name:
  377.             break
  378.         else:
  379.         raise IOError, "file not found"
  380.         node = kid
  381.     return node.sid
  382.  
  383.     def _open(self, start, size = 0x7FFFFFFF):
  384.     # openstream helper.
  385.  
  386.     if size < self.minisectorcutoff:
  387.         # ministream object
  388.         if not self.ministream:
  389.         self.loadminifat()
  390.         self.ministream = self._open(self.sidlist[0][2])
  391.         return _OleStream(self.ministream, start, size, 0,
  392.                   self.minisectorsize, self.minifat)
  393.  
  394.     # standard stream
  395.     return _OleStream(self.fp, start, size, 512,
  396.               self.sectorsize, self.fat)
  397.  
  398.     #
  399.     # public interface
  400.  
  401.     def listdir(self):
  402.     """Return a list of streams stored in this file"""
  403.  
  404.     files = []
  405.     self._list(files, [], self.root)
  406.     return files
  407.  
  408.     def openstream(self, filename):
  409.     """Open a stream as a read-only file object"""
  410.  
  411.     slot = self._find(filename)
  412.     name, type, sect, size, sids, clsid = self.sidlist[slot]
  413.     if type != 2:
  414.         raise IOError, "this file is not a stream"
  415.     return self._open(sect, size)
  416.  
  417.     def getproperties(self, filename):
  418.     """Return properties described in substream"""
  419.  
  420.     fp = self.openstream(filename)
  421.  
  422.     data = {}
  423.  
  424.     # header
  425.     s = fp.read(28)
  426.     clsid = self._clsid(s[8:24])
  427.  
  428.     # format id
  429.     s = fp.read(20)
  430.     fmtid = self._clsid(s[:16])
  431.     fp.seek(i32(s, 16))
  432.  
  433.     # get section
  434.     s = "****" + fp.read(i32(fp.read(4))-4)
  435.  
  436.     for i in range(i32(s, 4)):
  437.  
  438.         id = i32(s, 8+i*8)
  439.         offset = i32(s, 12+i*8)
  440.         type = i32(s, offset)
  441.  
  442.         # test for common types first (should perhaps use
  443.         # a dictionary instead?)
  444.  
  445.         if type == VT_I2:
  446.         value = i16(s, offset+4)
  447.         if value >= 32768:
  448.             value = value - 65536
  449.         elif type == VT_UI2:
  450.         value = i16(s, offset+4)
  451.         elif type in (VT_I4, VT_ERROR):
  452.         value = i32(s, offset+4)
  453.         elif type == VT_UI4:
  454.         value = i32(s, offset+4) # FIXME
  455.         elif type in (VT_BSTR, VT_LPSTR):
  456.         count = i32(s, offset+4)
  457.         value = s[offset+8:offset+8+count-1]
  458.         elif type == VT_BLOB:
  459.         count = i32(s, offset+4)
  460.         value = s[offset+8:offset+8+count]
  461.         elif type == VT_LPWSTR:
  462.         count = i32(s, offset+4)
  463.         value = self._unicode(s[offset+8:offset+8+count*2])
  464.         elif type == VT_FILETIME:
  465.         value = long(i32(s, offset+4)) + (long(i32(s, offset+8))<<32)
  466.         # FIXME: this is a 64-bit int: "number of 100ns periods
  467.         # since Jan 1,1601".  Should map this to Python time
  468.         value = value / 10000000L # seconds
  469.         elif type == VT_UI1:
  470.         value = ord(s[offset+4])
  471.         elif type == VT_CLSID:
  472.         value = self._clsid(s[offset+4:offset+20])
  473.         elif type == VT_CF:
  474.         count = i32(s, offset+4)
  475.         value = s[offset+8:offset+8+count]
  476.         else:
  477.         value = None # everything else yields "None"
  478.  
  479.         # FIXME: add support for VT_VECTOR
  480.  
  481.         #print "%08x" % id, repr(value),
  482.         #print "(%s)" % VT[i32(s, offset) & 0xFFF]
  483.  
  484.         data[id] = value
  485.  
  486.     return data
  487.  
  488. #
  489. # --------------------------------------------------------------------
  490. # This script can be used to dump the directory of any OLE2 structured
  491. # storage file.
  492.  
  493. if __name__ == "__main__":
  494.  
  495.     import sys
  496.  
  497.     for file in sys.argv[1:]:
  498.     try:
  499.         ole = OleFileIO(file)
  500.         print "-" * 68
  501.         print file
  502.         print "-" * 68
  503.         ole.dumpdirectory()
  504.         for file in ole.listdir():
  505.         if file[-1][0] == "\005":
  506.             print file
  507.             ole.getproperties(file)
  508.     except IOError:
  509.         pass
  510.